kanzi::BindingHostConcept Class Reference

BindingHostConcept specifies an interface for adding and removing bindings to the binding host. More...

#include <kanzi/core.ui/binding/binding_host_concept.hpp>

Inheritance diagram for kanzi::BindingHostConcept:

Public Types
using	BindingHostConceptSharedPtr
	Binding host concept shared pointer type.
using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.
using	BindingRuntimeContainer
	Container for binding runtimes.
using	BindingRuntimeIterator
	Iterator for binding runtimes.

Public Member Functions
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes.
BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes.
AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index.
size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node.
void	removeAllBindings ()
	Removes all binding runtimes.
void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier.
void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner.

Protected Member Functions
void	attachBindings ()
	Attach all bindings stored in this object.
void	detachBindings ()
	Detach bindings.

Protected Attributes
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object.

Detailed Description

BindingHostConcept specifies an interface for adding and removing bindings to the binding host.

Besides providing the interface, BindingHostConcept contains the binding runtimes.

Since

Kanzi.3.7.0

Member Typedef Documentation

BindingRuntimeContainer

using kanzi::BindingHostConcept::BindingRuntimeContainer

Container for binding runtimes.

BindingRuntimeIterator

using kanzi::BindingHostConcept::BindingRuntimeIterator

Iterator for binding runtimes.

BindingRuntimeConstIterator

using kanzi::BindingHostConcept::BindingRuntimeConstIterator

Const iterator for binding runtimes.

BindingHostConceptSharedPtr

using kanzi::BindingHostConcept::BindingHostConceptSharedPtr

Binding host concept shared pointer type.

Member Function Documentation

removeBinding()

void kanzi::BindingHostConcept::removeBinding

(

BindingRuntimeHandle &

bindingRuntime

)

Removes a binding runtime added earlier.

Parameters

bindingRuntime

Binding runtime to remove.

Since

Kanzi 3.9.7 changed AbstractBindingRuntime to BindingRuntimeHandle.

removeBindingsWithOwner()

void kanzi::BindingHostConcept::removeBindingsWithOwner

(

shared_ptr< void >

owner

)

Removes all binding runtimes with the specified owner.

Parameters

owner

Owner of the binding runtime.

removeAllBindings()

void kanzi::BindingHostConcept::removeAllBindings

(

)

Removes all binding runtimes.

beginBindingRuntimes()

BindingRuntimeConstIterator kanzi::BindingHostConcept::beginBindingRuntimes

(

)

const

Returns an iterator to the beginning of binding runtimes.

Returns

Const iterator to the beginning of binding runtimes.

endBindingRuntimes()

BindingRuntimeConstIterator kanzi::BindingHostConcept::endBindingRuntimes

(

)

const

Returns an iterator to the end of binding runtimes.

Returns

Const iterator to the end of binding runtimes.

getBindingRuntime()

AbstractBindingRuntimeSharedPtr kanzi::BindingHostConcept::getBindingRuntime

(

size_t

idx

)

Gets binding by index.

Parameters

idx	Index of binding to retrieve.

Returns

Binding runtime at index.

getBindingRuntimeCount()

size_t kanzi::BindingHostConcept::getBindingRuntimeCount

(

)

const

Gets the number of binding runtimes added to this node.

Returns

Number of bindings currently in the binding host.

attachBindings()

void kanzi::BindingHostConcept::attachBindings ( )

protected

Attach all bindings stored in this object.

detachBindings()

void kanzi::BindingHostConcept::detachBindings ( )

protected

Detach bindings.

Member Data Documentation

m_bindingRuntimes

BindingRuntimeContainer kanzi::BindingHostConcept::m_bindingRuntimes

protected

Bindings in this object.

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/binding/binding_host_concept.hpp